SetPreamble(byte[],int,int) Method

Summary

Sets the contents of the file's preamble.

Syntax

C++

Java

public void SetPreamble( 
   byte[] preamble, 
   int offset, 
   int length 
)

Public Overloads Sub SetPreamble( _ 
   ByVal preamble() As Byte, _ 
   ByVal offset As Integer, _ 
   ByVal length As Integer _ 
)

public void setPreamble(byte[] preamble, int offset, int length)

public: 
void SetPreamble(  
   array<byte>^ preamble, 
   int offset, 
   int length 
)

Parameters

preamble
Pointer to a buffer that represents the preamble to set.

offset
Value that represents the offset from the beginning of the buffer, from which this method should copy data.

length
Value that represents the length of the preamble, in bytes. The maximum length is 128 bytes.

Remarks

The standard length of the Preamble is 128 bytes. If the value specified in length is > 128, then the Preamble will be set with the first 128 bytes of preamble. If length is < or equal 128, then the Preamble will be set with the entire contents of preamble.

To retrieve the contents of the Preamble, call the GetPreamble method.

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms